CreateInvoiceQueryAmount
The CreateInvoiceQueryAmount web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables a Query Amount to be created in CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. for a valid Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. Number and Invoice Number, as specified in the request.
Submission of invalid data results in an error being returned.
The record is created on the Query Amount file which triggers the creation of a Workflow Event on the Account. The unique Workflow Number is returned in the web service response.
The Workflow Event is not resolved or processed and the Query Amount record is updated with the Workflow Number.
The external system identifies the relevant Posting Account for the Group, Corporate or Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription prior to calling the web service. Transactions for this Account are then queried by the external system to determine what invoices have been posted at that level.
CreateInvoiceQueryAmount Request
The CreateInvoiceQueryAmount tag instructs the Financials Service to create an invoice query amount. The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Account Number and Invoice Number. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
AccountNumber |
Integer8 |
The unique number automatically generated when the Account is created. |
Mandatory |
|
InvoiceNumber |
Integer8 |
Invoice Number to which the query belongs. |
Mandatory |
|
AmountInQuery |
Currency (Decimal) |
|
Mandatory |
|
QueryType |
String4 |
This must correspond to an Workflow Event Code configured in CMP for the Query Amount Workflow Event Type. |
Optional |
CreateInvoiceQueryAmount Response
The CreateInvoiceQueryAmount response is the response to the CreateInvoiceQueryAmount Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
WorkflowEventNumber |
Integer9 |
The Workflow Event Number associated with this query. |
Mandatory |
|
QueryNumber |
Integer8 |
Query Number used to identify the query. |
Mandatory |
If the requested Account Number or Invoice Number does not exist, the appropriate message is returned and standard exception processing is performed.